/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   Oct 30, 2020 (Mark Ortmann, KNIME GmbH, Berlin, Germany): created
 */
package org.knime.filehandling.utility.nodes.dialog.variables;

import java.awt.BorderLayout;
import java.awt.GridBagLayout;

import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.SwingConstants;

import org.knime.core.node.NodeSettingsRO;
import org.knime.core.node.NodeSettingsWO;
import org.knime.core.node.util.SharedIcons;
import org.knime.core.node.workflow.FlowVariable;
import org.knime.filehandling.core.connections.FSLocation;
import org.knime.filehandling.core.util.GBCBuilder;

/**
 * A panel that allows to add and remove entries that eventually will be used to create {@link FlowVariable}s based on
 * {@link FSLocation}s.
 *
 * @author Mark Ortmann, KNIME GmbH, Berlin, Germany
 */
public final class FSLocationVariablePanel extends JPanel {

    private static final long serialVersionUID = 1L;

    private final FSLocationVariableTable m_table;

    private final JButton m_add;

    private final JButton m_remove;

    /**
     * Constructor.
     *
     * @param model the {@link FSLocationVariableTableModel}
     */
    public FSLocationVariablePanel(final FSLocationVariableTableModel model) {
        super(new GridBagLayout());
        GBCBuilder gbc =
            new GBCBuilder().anchorLineStart().setWeightX(1).setWeightY(1).fillBoth().resetX().resetY().setHeight(3);

        m_table = new FSLocationVariableTable(model);
        m_table.setPreferredScrollableViewportSize(null);
        add(new JScrollPane(m_table), gbc.build());

        gbc = gbc.incX().setWeightX(0).fillNone().setHeight(1).insetLeft(5).setWeightY(0).fillNone()
            .insetTop(m_table.getTableHeader().getPreferredSize().height);
        m_add = createButton(SharedIcons.ADD_PLUS.get(), "Add variable");
        m_add.addActionListener(l -> m_table.addEntry());
        add(m_add, gbc.build());

        gbc = gbc.incY().insetTop(10);
        m_remove = createButton(SharedIcons.DELETE_TRASH.get(), " Remove variable");
        m_remove.addActionListener(l -> m_table.removeEntries());
        add(m_remove, gbc.build());

        m_add.setPreferredSize(m_remove.getPreferredSize());

        m_table.getSelectionModel().addListSelectionListener(x -> toggleRemoveButton());
    }

    private void toggleRemoveButton() {
        m_remove.setEnabled(m_table.getSelectedRow() != -1);
    }

    private static JButton createButton(final Icon icon, final String label) {
        final JButton button = new JButton();
        button.setLayout(new BorderLayout());
        button.add(new JLabel(icon), BorderLayout.WEST);
        button.add(new JLabel(label, SwingConstants.CENTER), BorderLayout.CENTER);
        return button;
    }

    /**
     * Loads the settings.
     *
     * @param settings the {@link NodeSettingsRO} to read from
     */
    public void loadSettings(final NodeSettingsRO settings) {
        m_table.loadSettings(settings);
        toggleRemoveButton();
    }

    /**
     * Saves the settings.
     *
     * @param settings the {@link NodeSettingsWO} to write to
     */
    public void saveSettings(final NodeSettingsWO settings) {
        m_table.saveSettings(settings);
    }

    /**
     * Cancels any open editors when the dialog is closed.
     */
    public void onClose() {
        m_table.onClose();
    }

}
